Vcenter NamespaceManagement Supervisors ManagementServices CreateSpec

Vcenter NamespaceManagement Supervisors ManagementServices CreateSpec
Vcenter NamespaceManagement Supervisors ManagementServices CreateSpec

The Vcenter NamespaceManagement Supervisors ManagementServices CreateSpec schema provides a specification required to register a Management Service with a Supervisor.

This schema was added in vSphere API 9.1.0.0.

JSON Example
{
    "management_service": "string",
    "description": "string",
    "managed_by": "string",
    "management_addresses": [
        "string"
    ],
    "ports": [
        {
            "name": "string",
            "port": 0,
            "transport_protocol": "string",
            "tls": {
                "certificate_authority_chain": "string",
                "hostname": "string"
            }
        }
    ]
}
string
management_service
Required

Identifier of the Management Service. The identifier has DNS Label restrictions as specified in : it must be an alphanumeric (a-z and 0-9) string, with a maximum length of 63 characters and with '-' character allowed anywhere except the first or last character. This identifier must be unique across all Management Services in the Supervisor.

This property was added in vSphere API 9.1.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.ManagementService. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.ManagementService.

string
description
Optional

A human-readable description of the Management Service.

This property was added in vSphere API 9.1.0.0.

If missing or null, the Management Service will not have a description.

string
managed_by
Optional

Human-readable information about the entity responsible for the lifecycle of this Management Service record.

When set, the field implies that any change to update or delete the Management Service by any principal other than the component referenced by the field may be reverted by the automation component managing it.

This field should be left missing or null for a Management Service directly managed by human users via vSphere UI or API. It should be set when the Management Service is being created by an external automation entity with integration with vSphere API.

This property was added in vSphere API 9.1.0.0.

If missing or null, it implies the Management Service is not created by automation.

array of string
management_addresses
Required

A full list of IP addresses and/or fully-qualified domain names on which the Management Service is running.

This property was added in vSphere API 9.1.0.0.

array of Vcenter NamespaceManagement Supervisors ManagementServices ServicePortCreateSpec
ports
Required

Ports information for the Service. Each port in the list is expected to be present on each address listed in managementAddresses.

This property was added in vSphere API 9.1.0.0.

Parameter To